home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 27.zip / BS1 part 27 / Brillance_d1.adf / ReadMe < prev    next >
Text File  |  1993-08-23  |  9KB  |  296 lines
  1. Brilliance ReadMe
  2. -----------------
  3.  
  4. $VER: Brilliance_ReadMe 1.0 (30.7.93)
  5. $Release 1.0
  6. $Revision: 1.4 $
  7. $Date: 1993/07/30 17:40:30 $
  8.  
  9.  
  10. Introduction
  11. ------------
  12.  
  13. This file contains additional Brilliance documentation.  At present it
  14. contains only tool types descriptions.
  15.  
  16.  
  17. Tool Types
  18. ----------
  19.  
  20. This section describes the tool types used by Brilliance, their load and
  21. save behavior, ranges, and default settings.
  22.  
  23. Please note that all tool types are to be typed as shown.  Uppercase and
  24. lowercase letters are significant and must be used as per the examples.
  25. Any unknown or unsupported tool types entered will be ignored.  The order
  26. in which they appear is not important.
  27.  
  28. Syntax:
  29.  
  30.     M..N         Used to describe a range of numbers from which to choose
  31.                  a number from.  (e.g. 3..14 describes a range from 3 to 14
  32.                  inclusive)  Any number chosen within the specified range
  33.                  is valid.
  34.  
  35. item1|item2...   Used to denote a list of items from which exactly one item
  36.                  may be chosen.  (e.g. Red|Green|Blue is a list from which a
  37.                  user may select Red, Green or Blue as a valid choice)
  38.  
  39.    <item>        Describes a spot were the labeled item is to be placed.
  40.                  (e.g. <license> - put the license number at this location)
  41.  
  42.   {<item>}       Replace with any number of things suitable for <item>
  43.                  separated by spaces.  (e.g. {<animal>} might be replaced
  44.                  by: cat dog bird horse pig)
  45.  
  46.       =          Used as a separator between the tool type name and its value
  47.                  or attribute.  It is used after the last letter of the tool
  48.                  type name and the first character of its value.
  49.  
  50.  
  51. Preferences Requester Items
  52. ---------------------------
  53.  
  54. These items describe Preferences requester settings.  They are saved into
  55. the program icon during Save Preferences and are loaded during program
  56. startup.
  57.  
  58.     PREFS.AUTOSCROLL_SCREENS=On|Off
  59.         Setting of Autoscroll Screens gadget.  Defaults to Off.
  60.  
  61.     PREFS.CREATE_ICONS=On|Off
  62.         Setting of Create Icons gadget.  Defaults to On.
  63.  
  64.     PREFS.RELATIVE_COORDS=On|Off
  65.         Setting of Relative Coordinates gadget.  Defaults to On.
  66.  
  67.     PREFS.UNDO_KBYTES=0..999999
  68.         Setting of Undo Buffer Size gadget in KBytes.  Defaults to 1K.
  69.  
  70.     PREFS.WORKBENCH=On|Off
  71.         Setting of Workbench gadget.  Defaults to Off.
  72.  
  73.  
  74. Runtime Editable Items
  75. ----------------------
  76.  
  77. These items describe program options that are saved to the program icon
  78. during Save Preferences, but are not directly editable from within the
  79. Preferences requester.  They are also loaded during program startup.
  80.  
  81.     BUFFER.TRUE_COLOR_DEPTH=15|24
  82.        True color buffer depth.  Defaults to be in sync with default screen
  83.        depth.  (TrueBrilliance only)
  84.  
  85.     MENU_KEY.1={<menu>}
  86.     MENU_KEY.2={<menu>}
  87.         .
  88.         .
  89.     MENU_KEY.9={<menu>}
  90.         Menu hotkey descriptions containing the set of menus for each key.
  91.         Substitute {<menu>} with any combination of the below menu keywords
  92.         separated by spaces.
  93.  
  94.         (e.g. MENU_KEY.2=Brush AnimBrush Distort)
  95.  
  96.         Menus Names:
  97.             Airbrush
  98.             Animation
  99.             AnimBrush
  100.             AntiAlias
  101.             Brush
  102.             Buffer
  103.             Distort
  104.             DrawMode
  105.             Ellipse
  106.             Gradient
  107.             Grid
  108.             Mirror
  109.             Palette
  110.             PenTip
  111.             Rectangle
  112.             Segment
  113.             Stencil
  114.             Transparency (or Transparent)
  115.             Tweening
  116.  
  117.     SCREEN.MODEID=<modeid>
  118.         Display mode id in hexadecimal.  Defaults to HIRESLACE(HAM) or
  119.         LORES(HAM) depending on AGA and available memory.
  120.  
  121.         Since this item is saved by preferences, you don't really need to
  122.         understand the magic numbers used here.  It's best to leave this
  123.         alone if you don't understand it.
  124.  
  125.     SCREEN.WIDTH=1..16368
  126.         Screen width in pixels.  Defaults to nominal dimensions for default
  127.         mode.
  128.  
  129.     SCREEN.HEIGHT=1..16384
  130.         Screen height in pixels.  Defaults to nominal dimensions for default
  131.         mode.
  132.  
  133.     SCREEN.DEPTH=1..8
  134.         Screen depth in bitplanes.  Defaults to maximum depth for default
  135.         mode.
  136.  
  137.     SCREEN.OVERSCAN=Text|Graphics|Maximum|Video
  138.         Overscan display clip description.
  139.  
  140.  
  141. Program Control Items
  142. ---------------------
  143.  
  144. These items control the operation of Brilliance and are read during
  145. program startup.
  146.  
  147.     SERIAL_NUMBER=<serial #>
  148.         The serial number of your security key is placed next to this tool
  149.         type.
  150.  
  151.     PATCH_TEST=On|Off
  152.         Enables looking for SetPatchMrgCop during startup.  Defaults to On.
  153.  
  154.  
  155. Initial Settings
  156. ----------------
  157.  
  158. These items are loaded during program startup, but are not saved with
  159. Preferences.  They influence the initial state of many various program
  160. settings.  You may enter any combination of these into the Brilliance and
  161. TrueBrilliance icons to customize the initial state of the programs to
  162. suit your taste.
  163.  
  164.     AIRBRUSH.FLOW=0..100
  165.        Initial Airbrush flow setting.  Defaults to 100.
  166.  
  167.     AIRBRUSH.FOCUS=0..100
  168.        Initial Airbrush focus setting (0 concentrated, 100 evenly
  169.        distributed).  Defaults to 100.
  170.  
  171.     AIRBRUSH.SIZE=0..16384
  172.        Initial Airbrush size.  Defaults to 30.
  173.  
  174.     BRUSH.AUTO_BG=On|Off
  175.        Initial state of Brush menu AUTO BG gadget.  Defaults to Off.
  176.  
  177.     BRUSH.HANDLE_CORNER=On|Off
  178.        Initial favorite Brush handle type, On: Use most recently cut corner.
  179.        Off: Use center.  Defaults to Off.
  180.  
  181.     BRUSH.TILE_CUT=On|Off
  182.        Initial state of Brush menu TILE CUT gadget.  Defaults to Off.
  183.  
  184.     ELLIPSE.CENTER_TO_CORNER=On|Off
  185.        Initial state of Ellipse menu CENTER TO CORNER gadget.  Defaults to
  186.        On.
  187.  
  188.     ELLIPSE.ROTATE=On|Off
  189.        Initial state of Ellipse menu ROTATE gadget.  Defaults to Off.
  190.  
  191.     FAST_FEEDBACK=On|Off
  192.        Initial state of primary menu FAST FEEDBACK gadget.  Defaults to Off
  193.        if running on a 68020 or better, defaults to On otherwise.
  194.  
  195.     FILE.DRAWER.PICTURE=<drawer>
  196.        Initial drawer name for Load/Save Picture.
  197.  
  198.     FILE.DRAWER.BRUSH=<drawer>
  199.        Initial drawer name for Load/Save Brush.
  200.  
  201.     FILE.DRAWER.ANIM=<drawer>
  202.        Initial drawer name for Load/Save Animation.
  203.  
  204.     FILE.DRAWER.ANIMBRUSH=<drawer>
  205.        Initial drawer name for Load/Save Anim-Brush.
  206.  
  207.     FILE.DRAWER.STENCIL=<drawer>
  208.        Initial drawer name for Load/Save Stencil.
  209.  
  210.     FILE.DRAWER.PALETTE=<drawer>
  211.        Initial drawer name for Load/Save Palette.
  212.  
  213.     FILE.DEFAULT_PALETTE=<file>
  214.        Default palette file name (can be relative to FILE.DRAWER.PALETTE)
  215.        Defaults to empty string which means to use built-in palette.
  216.  
  217.     FILE.SAVE_DEFAULT_TOOL=<program>
  218.        Name of default tool to write with project icons.  Defaults to full
  219.        path name for Brilliance or TrueBrilliance.
  220.  
  221.     FILE.SAVE_IMAGE_TYPE=HAM|TrueColor
  222.        Initial image type for Save Picture and Brush.  HAM selects "HAM-6"
  223.        or "HAM-8".  TrueColor selects "15-bit RGB" or "24-bit RGB".
  224.        Defaults to HAM.  (TrueBrilliance only)
  225.  
  226.     FILE.SAVE_ANIM_TYPE=OP5|OP8W|OP8L
  227.        Initial animation type for Save Animation.  Defaults to Op-5.
  228.  
  229.     GRID.X_OFFSET=0..999
  230.        Initial grid menu X Offset.  Defaults to 0.
  231.  
  232.     GRID.Y_OFFSET=0..999
  233.        Initial grid menu Y Offset.  Defaults to 0.
  234.  
  235.     GRID.WIDTH=1..999
  236.        Initial grid menu Width setting.  Defaults to 16.
  237.  
  238.     GRID.HEIGHT=1..999
  239.         Initial grid menu Height setting.  Defaults to 16.
  240.  
  241.     MAGNIFICATION.DIVIDE_PIXELS=On|Off
  242.        Initial state of magnification "divide pixels" feature.  Defaults to
  243.        On.  (Brilliance only)
  244.  
  245.     MAGNIFICATION.FACTOR=2..32
  246.        Initial magnification factor.  Defaults to 4.
  247.  
  248.     PALETTE.BITS_PER_GUN=1..8
  249.        Initial screen requester bits/gun setting.  Defaults to maximum.
  250.        (Brilliance only)
  251.  
  252.     PALETTE.COLOR_MODEL=RGB|HSV|CMY
  253.        Initial color model for palette menu sliders.  Defaults to RGB.
  254.  
  255.     RECTANGLE.CENTER_TO_CORNER=On|Off
  256.        Initial state of rectangle menu CENTER TO CORNER gadget.  Defaults
  257.        to Off.
  258.  
  259.     STENCIL.VARIANCE.H=0..100
  260.     STENCIL.VARIANCE.S=0..100
  261.     STENCIL.VARIANCE.V=0..100
  262.        Initial state of stencil menu variance sliders.  Defaults to 10.
  263.        (TrueBrilliance only)
  264.  
  265.     TRANSPARENCY.MIXING=RGB|HSV
  266.        Initial transparency menu mixing type.  Defaults to RGB.
  267.  
  268.     TRANSPARENCY.OPACITY=0..100
  269.        Initial transparency menu opacity value.  Defaults to 50.
  270.  
  271.  
  272. Sample tool type list for Brilliance:
  273. -------------------------------------
  274.  
  275. SERIAL_NUMBER=2134 1234 1234 2134 1234 1234
  276. SCREEN.OVERSCAN=Video
  277. SCREEN.WIDTH=640
  278. SCREEN.HEIGHT=400
  279. MENU_KEY.1=Animation Buffer
  280. MENU_KEY.2=AnimBrush Brush Distort
  281. BRUSH.AUTO_BG=Off
  282. BRUSH.HANDLE_CORNER=On
  283. BRUSH.TILE_CUT=On
  284. GRID.WIDTH=100
  285. GRID.HEIGHT=50
  286. PALETTE.COLOR_MODEL=HSV
  287. RECTANGLE.CENTER_TO_CORNER=Off
  288. FILE.DRAWER.PICTURE=work:brilliance/pictures
  289. FILE.DRAWER.BRUSH=work:brilliance/brush
  290. FILE.DRAWER.ANIM=work:brilliance/anim
  291. FILE.DRAWER.ANIMBRUSH=work:artwork/animbrushes
  292. FILE.DRAWER.STENCIL=work:stencils
  293. FILE.DRAWER.PALETTE=work:artwork/palettes
  294. FILE.SAVE_DEFAULT_TOOL=work:tools/brilliance
  295. FILE.SAVE_ANIM_TYPE=OP8L
  296.